Ultrasonic 3 Click Driver

API for configuring and manipulating Ultrasonic 3 Click driver. More...

Topics
	Ultrasonic 3 Registers Settings
	Settings for registers of Ultrasonic 3 Click driver.
	Ultrasonic 3 MikroBUS Map
	MikroBUS pin mapping of Ultrasonic 3 Click driver.

Functions
void	ultrasonic3_cfg_setup (ultrasonic3_cfg_t *cfg)
	Ultrasonic 3 configuration object setup function.
err_t	ultrasonic3_init (ultrasonic3_t *ctx, ultrasonic3_cfg_t *cfg)
	Ultrasonic 3 initialization function.
err_t	ultrasonic3_default_cfg (ultrasonic3_t *ctx)
	Ultrasonic 3 default configuration function.
err_t	ultrasonic3_set_duty_cycle (ultrasonic3_t *ctx, float duty_cycle)
	Ultrasonic 3 sets PWM duty cycle.
err_t	ultrasonic3_pwm_stop (ultrasonic3_t *ctx)
	Ultrasonic 3 stop PWM module.
err_t	ultrasonic3_pwm_start (ultrasonic3_t *ctx)
	Ultrasonic 3 start PWM module.
void	ultrasonic3_get_measurements (void)
	Ultrasonic 3 get measurements function.

Detailed Description

API for configuring and manipulating Ultrasonic 3 Click driver.

Any initialization code needed for MCU to function properly. Do not remove this line or clock might not be set correctly.

Function Documentation

ultrasonic3_cfg_setup()

void ultrasonic3_cfg_setup

(

ultrasonic3_cfg_t *

cfg

)

Ultrasonic 3 configuration object setup function.

This function initializes Click configuration structure to initial values.

Parameters

[out]

cfg

: Click configuration structure. See ultrasonic3_cfg_t object definition for detailed explanation.

Returns

Nothing.

Note

The all used pins will be set to unconnected state.

ultrasonic3_default_cfg()

err_t ultrasonic3_default_cfg

(

ultrasonic3_t *

ctx

)

Ultrasonic 3 default configuration function.

This function executes a default configuration of Ultrasonic 3 Click board.

Parameters

[in]

ctx

: Click context object. See ultrasonic3_t object definition for detailed explanation.

Returns

• 0 - Success,
• -1 - Error. See #err_t definition for detailed explanation.

Note

This function can consist any necessary configuration or setting to put device into operating mode.

ultrasonic3_get_measurements()

void ultrasonic3_get_measurements

(

void

)

Ultrasonic 3 get measurements function.

This function triggers and reads the measurements and logs data.

Returns

None.

Note

None.

ultrasonic3_init()

err_t ultrasonic3_init	(	ultrasonic3_t *	ctx,
		ultrasonic3_cfg_t *	cfg )

Ultrasonic 3 initialization function.

This function initializes all necessary pins and peripherals used for this Click board.

Parameters

[out]	ctx	: Click context object. See ultrasonic3_t object definition for detailed explanation.
[in]	cfg	: Click configuration structure. See ultrasonic3_cfg_t object definition for detailed explanation.

Returns

• 0 - Success,
• -1 - Error. See #err_t definition for detailed explanation.

Note

None.

ultrasonic3_pwm_start()

err_t ultrasonic3_pwm_start

(

ultrasonic3_t *

ctx

)

Ultrasonic 3 start PWM module.

This function starts the PWM module output.

Parameters

[in]

ctx

: Click context object. See ultrasonic3_t object definition for detailed explanation.

Returns

• 0 - Success,
• -1 - Error. See #err_t definition for detailed explanation.

Note

None.

ultrasonic3_pwm_stop()

err_t ultrasonic3_pwm_stop

(

ultrasonic3_t *

ctx

)

Ultrasonic 3 stop PWM module.

This function stops the PWM module output.

Parameters

[in]

ctx

: Click context object. See ultrasonic3_t object definition for detailed explanation.

Returns

• 0 - Success,
• -1 - Error. See #err_t definition for detailed explanation.

Note

None.

ultrasonic3_set_duty_cycle()

err_t ultrasonic3_set_duty_cycle	(	ultrasonic3_t *	ctx,
		float	duty_cycle )

Ultrasonic 3 sets PWM duty cycle.

This function sets the PWM duty cycle in percentages ( Range[ 0..1 ] ).

Parameters

[in]	ctx	: Click context object. See ultrasonic3_t object definition for detailed explanation.
[in]	duty_cycle	: PWM duty cycle.

Returns

• 0 - Success,
• -1 - Error. See #err_t definition for detailed explanation.

Note

None.